<!-- HTML header for doxygen 1.8.20-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
	<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
	<meta http-equiv="X-UA-Compatible" content="IE=9"/>
	<meta name="generator" content="Doxygen 1.9.4"/>
	<meta name="viewport" content="width=device-width, initial-scale=1"/>
	<title>Raspberry Pi Pico SDK: include/pico/async_context_threadsafe_background.h Source File</title>
	<!-- <link href="tabs.css" rel="stylesheet" type="text/css"/> -->
	<script type="text/javascript" src="jquery.js"></script>
	<script type="text/javascript" src="dynsections.js"></script>
	<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
	<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
    <link href="https://fonts.googleapis.com/css2?family=Roboto:wght@300;400;500&display=swap" rel="stylesheet">
	<link href="doxygen.css" rel="stylesheet" type="text/css" />
	<link href="normalise.css" rel="stylesheet" type="text/css"/>
<link href="main.css" rel="stylesheet" type="text/css"/>
<link href="styles.css" rel="stylesheet" type="text/css"/>
</head>
<body>
	<div class="navigation-mobile">
		<div class="logo--mobile">
			<a href="/"><img src="logo-mobile.svg" alt="Raspberry Pi"></a>
		</div>
		<div class="navigation-toggle">
			<span class="line-1"></span>
			<span class="line-2">
				<p>Menu Toggle</p>
			</span>
			<span class="line-3"></span>
		</div>
	</div>
	<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
		<div class="logo">
			<a href="index.html"> <img src="logo.svg" alt="Raspberry Pi"></a>
			<span style="display: inline-block; margin-top: 10px;">
				v2.1.0
			</span>
		</div>
		<div class="navigation-footer">
			<img src="logo-mobile.svg" alt="Raspberry Pi">
			<a href="https://www.raspberrypi.com/" target="_blank">By Raspberry Pi Ltd</a>
		</div>
<!-- 		<div class="search">
			<form>
				<input type="search" name="search" id="search" placeholder="Search">
				<input type="submit" value="Search">
			</form>
		</div> -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('async__context__threadsafe__background_8h_source.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="headertitle"><div class="title">async_context_threadsafe_background.h</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">/*</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment"> * Copyright (c) 2022 Raspberry Pi (Trading) Ltd.</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment"> *</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment"> * SPDX-License-Identifier: BSD-3-Clause</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment"> */</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span> </div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="preprocessor">#ifndef _PICO_ASYNC_CONTEXT_THREADSAFE_BACKGROUND_H</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="preprocessor">#define _PICO_ASYNC_CONTEXT_THREADSAFE_BACKGROUND_H</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span> </div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span><span class="preprocessor">#include &quot;<a class="code" href="async__context_8h.html">pico/async_context.h</a>&quot;</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span><span class="preprocessor">#include &quot;<a class="code" href="sem_8h.html">pico/sem.h</a>&quot;</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span><span class="preprocessor">#include &quot;<a class="code" href="mutex_8h.html">pico/mutex.h</a>&quot;</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span><span class="preprocessor">#include &quot;<a class="code" href="irq_8h.html">hardware/irq.h</a>&quot;</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span> </div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span><span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span><span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span> </div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span><span class="preprocessor">#ifndef ASYNC_CONTEXT_THREADSAFE_BACKGROUND_MULTI_CORE</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span><span class="preprocessor">#define ASYNC_CONTEXT_THREADSAFE_BACKGROUND_MULTI_CORE LIB_PICO_MULTICORE</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span> </div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="structasync__context__threadsafe__background.html">async_context_threadsafe_background</a> <a class="code hl_struct" href="structasync__context__threadsafe__background.html">async_context_threadsafe_background_t</a>;</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span> </div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"><a class="line" href="structasync__context__threadsafe__background__config.html">   38</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="structasync__context__threadsafe__background__config.html">async_context_threadsafe_background_config</a> {</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"><a class="line" href="structasync__context__threadsafe__background__config.html#aaeed113746710afc683e1495409d66d8">   42</a></span>    uint8_t <a class="code hl_variable" href="structasync__context__threadsafe__background__config.html#aaeed113746710afc683e1495409d66d8">low_priority_irq_handler_priority</a>;</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"><a class="line" href="structasync__context__threadsafe__background__config.html#a8776bae13027752f07a4f3170b2c47b2">   53</a></span>    <a class="code hl_struct" href="structalarm__pool.html">alarm_pool_t</a> *<a class="code hl_variable" href="structasync__context__threadsafe__background__config.html#a8776bae13027752f07a4f3170b2c47b2">custom_alarm_pool</a>;</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span>} <a class="code hl_struct" href="structasync__context__threadsafe__background__config.html">async_context_threadsafe_background_config_t</a>;</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span> </div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"><a class="line" href="structasync__context__threadsafe__background.html">   56</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structasync__context__threadsafe__background.html">async_context_threadsafe_background</a> {</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span>    <a class="code hl_struct" href="structasync__context.html">async_context_t</a> core;</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span>    <a class="code hl_struct" href="structalarm__pool.html">alarm_pool_t</a> *<a class="code hl_struct" href="structalarm__pool.html">alarm_pool</a>; <span class="comment">// this must be on the same core as core_num</span></div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span>    <a class="code hl_typedef" href="group__timestamp.html#ga8b7f3d602cc053f05bacceeacc257ed8">absolute_time_t</a> last_set_alarm_time;</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno">   60</span>    <a class="code hl_struct" href="structrecursive__mutex__t.html">recursive_mutex_t</a> lock_mutex;</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span>    <a class="code hl_struct" href="structsemaphore.html">semaphore_t</a> work_needed_sem;</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span>    <span class="keyword">volatile</span> <a class="code hl_typedef" href="group__alarm.html#gaa593548569c182a0d65d2e06a9c3493b">alarm_id_t</a> alarm_id;</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span><span class="preprocessor">#if ASYNC_CONTEXT_THREADSAFE_BACKGROUND_MULTI_CORE</span></div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span>    <span class="keyword">volatile</span> <a class="code hl_typedef" href="group__alarm.html#gaa593548569c182a0d65d2e06a9c3493b">alarm_id_t</a> force_alarm_id;</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span>    <span class="keywordtype">bool</span> alarm_pool_owned;</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno">   67</span>    uint8_t low_priority_irq_num;</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno">   68</span>    <span class="keyword">volatile</span> <span class="keywordtype">bool</span> alarm_pending;</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno">   69</span>};</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno">   70</span> </div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno">   82</span><span class="keywordtype">bool</span> <a class="code hl_function" href="group__async__context__threadsafe__background.html#gabf48cafcbfa48c9fbef1aa7a18ded9e5">async_context_threadsafe_background_init</a>(<a class="code hl_struct" href="structasync__context__threadsafe__background.html">async_context_threadsafe_background_t</a> *self, <a class="code hl_struct" href="structasync__context__threadsafe__background__config.html">async_context_threadsafe_background_config_t</a> *config);</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno">   83</span> </div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno">   91</span><a class="code hl_struct" href="structasync__context__threadsafe__background__config.html">async_context_threadsafe_background_config_t</a> <a class="code hl_function" href="group__async__context__threadsafe__background.html#gaf8eafbbac141e7f24e377c708ffa1479">async_context_threadsafe_background_default_config</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno">   92</span> </div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"><a class="line" href="group__async__context__threadsafe__background.html#gab8bc5211f18cbc3a6817b1bf82020f8e">  103</a></span><span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="group__async__context__threadsafe__background.html#gab8bc5211f18cbc3a6817b1bf82020f8e">async_context_threadsafe_background_init_with_defaults</a>(<a class="code hl_struct" href="structasync__context__threadsafe__background.html">async_context_threadsafe_background_t</a> *self) {</div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno">  104</span>    <a class="code hl_struct" href="structasync__context__threadsafe__background__config.html">async_context_threadsafe_background_config_t</a> config = <a class="code hl_function" href="group__async__context__threadsafe__background.html#gaf8eafbbac141e7f24e377c708ffa1479">async_context_threadsafe_background_default_config</a>();</div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno">  105</span>    <span class="keywordflow">return</span> <a class="code hl_function" href="group__async__context__threadsafe__background.html#gabf48cafcbfa48c9fbef1aa7a18ded9e5">async_context_threadsafe_background_init</a>(self, &amp;config);</div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno">  106</span>}</div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno">  107</span> </div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno">  108</span><span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno">  109</span>}</div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno">  110</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno">  111</span> </div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno">  112</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="aasync__context_8h_html"><div class="ttname"><a href="async__context_8h.html">async_context.h</a></div></div>
<div class="ttc" id="agroup__alarm_html_gaa593548569c182a0d65d2e06a9c3493b"><div class="ttname"><a href="group__alarm.html#gaa593548569c182a0d65d2e06a9c3493b">alarm_id_t</a></div><div class="ttdeci">int32_t alarm_id_t</div><div class="ttdoc">The identifier for an alarm.</div><div class="ttdef"><b>Definition:</b> time.h:367</div></div>
<div class="ttc" id="agroup__async__context__threadsafe__background_html_gab8bc5211f18cbc3a6817b1bf82020f8e"><div class="ttname"><a href="group__async__context__threadsafe__background.html#gab8bc5211f18cbc3a6817b1bf82020f8e">async_context_threadsafe_background_init_with_defaults</a></div><div class="ttdeci">static bool async_context_threadsafe_background_init_with_defaults(async_context_threadsafe_background_t *self)</div><div class="ttdoc">Initialize an async_context_threadsafe_background instance with default values.</div><div class="ttdef"><b>Definition:</b> async_context_threadsafe_background.h:103</div></div>
<div class="ttc" id="agroup__async__context__threadsafe__background_html_gabf48cafcbfa48c9fbef1aa7a18ded9e5"><div class="ttname"><a href="group__async__context__threadsafe__background.html#gabf48cafcbfa48c9fbef1aa7a18ded9e5">async_context_threadsafe_background_init</a></div><div class="ttdeci">bool async_context_threadsafe_background_init(async_context_threadsafe_background_t *self, async_context_threadsafe_background_config_t *config)</div><div class="ttdoc">Initialize an async_context_threadsafe_background instance using the specified configuration.</div><div class="ttdef"><b>Definition:</b> async_context_threadsafe_background.c:195</div></div>
<div class="ttc" id="agroup__async__context__threadsafe__background_html_gaf8eafbbac141e7f24e377c708ffa1479"><div class="ttname"><a href="group__async__context__threadsafe__background.html#gaf8eafbbac141e7f24e377c708ffa1479">async_context_threadsafe_background_default_config</a></div><div class="ttdeci">async_context_threadsafe_background_config_t async_context_threadsafe_background_default_config(void)</div><div class="ttdoc">Return a copy of the default configuration object used by async_context_threadsafe_background_init_wi...</div><div class="ttdef"><b>Definition:</b> async_context_threadsafe_background.c:28</div></div>
<div class="ttc" id="agroup__timestamp_html_ga8b7f3d602cc053f05bacceeacc257ed8"><div class="ttname"><a href="group__timestamp.html#ga8b7f3d602cc053f05bacceeacc257ed8">absolute_time_t</a></div><div class="ttdeci">uint64_t absolute_time_t</div><div class="ttdoc">An opaque 64 bit timestamp in microseconds.</div><div class="ttdef"><b>Definition:</b> types.h:43</div></div>
<div class="ttc" id="airq_8h_html"><div class="ttname"><a href="irq_8h.html">irq.h</a></div></div>
<div class="ttc" id="amutex_8h_html"><div class="ttname"><a href="mutex_8h.html">mutex.h</a></div></div>
<div class="ttc" id="asem_8h_html"><div class="ttname"><a href="sem_8h.html">sem.h</a></div></div>
<div class="ttc" id="astructalarm__pool_html"><div class="ttname"><a href="structalarm__pool.html">alarm_pool</a></div><div class="ttdef"><b>Definition:</b> time.c:28</div></div>
<div class="ttc" id="astructasync__context__threadsafe__background__config_html"><div class="ttname"><a href="structasync__context__threadsafe__background__config.html">async_context_threadsafe_background_config</a></div><div class="ttdoc">Configuration object for async_context_threadsafe_background instances.</div><div class="ttdef"><b>Definition:</b> async_context_threadsafe_background.h:38</div></div>
<div class="ttc" id="astructasync__context__threadsafe__background__config_html_a8776bae13027752f07a4f3170b2c47b2"><div class="ttname"><a href="structasync__context__threadsafe__background__config.html#a8776bae13027752f07a4f3170b2c47b2">async_context_threadsafe_background_config::custom_alarm_pool</a></div><div class="ttdeci">alarm_pool_t * custom_alarm_pool</div><div class="ttdoc">a specific alarm pool to use (or NULL to use ta default)</div><div class="ttdef"><b>Definition:</b> async_context_threadsafe_background.h:53</div></div>
<div class="ttc" id="astructasync__context__threadsafe__background__config_html_aaeed113746710afc683e1495409d66d8"><div class="ttname"><a href="structasync__context__threadsafe__background__config.html#aaeed113746710afc683e1495409d66d8">async_context_threadsafe_background_config::low_priority_irq_handler_priority</a></div><div class="ttdeci">uint8_t low_priority_irq_handler_priority</div><div class="ttdoc">the priority of the low priority IRQ</div><div class="ttdef"><b>Definition:</b> async_context_threadsafe_background.h:42</div></div>
<div class="ttc" id="astructasync__context__threadsafe__background_html"><div class="ttname"><a href="structasync__context__threadsafe__background.html">async_context_threadsafe_background</a></div><div class="ttdef"><b>Definition:</b> async_context_threadsafe_background.h:56</div></div>
<div class="ttc" id="astructasync__context_html"><div class="ttname"><a href="structasync__context.html">async_context</a></div><div class="ttdoc">Base structure type of all async_contexts. For details about its use, see pico_async_context.</div><div class="ttdef"><b>Definition:</b> async_context.h:179</div></div>
<div class="ttc" id="astructrecursive__mutex__t_html"><div class="ttname"><a href="structrecursive__mutex__t.html">recursive_mutex_t</a></div><div class="ttdoc">recursive mutex instance</div><div class="ttdef"><b>Definition:</b> mutex.h:47</div></div>
<div class="ttc" id="astructsemaphore_html"><div class="ttname"><a href="structsemaphore.html">semaphore</a></div><div class="ttdef"><b>Definition:</b> sem.h:31</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->

	<script src="main.js"></script>
</body>
</html>